Skip to main content
PUT
/
v1
/
prompt-tools
Update Prompt Tool
curl --request PUT \
  --url https://api.getmaxim.ai/v1/prompt-tools \
  --header 'Content-Type: application/json' \
  --header 'x-maxim-api-key: <api-key>' \
  --data '
{
  "workspaceId": "<string>",
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "config": {
    "args": "<string>",
    "code": "<string>",
    "schema": {
      "type": "function",
      "function": {
        "name": "<string>",
        "description": "<string>",
        "parameters": {}
      }
    },
    "lang": "javascript",
    "scripts": "<string>",
    "sample": "<string>"
  },
  "folderId": "<string>",
  "newWorkspaceId": "<string>"
}
'
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "type": "<string>",
    "workspaceId": "<string>",
    "accountId": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "config": "<unknown>",
    "folderId": "<string>",
    "fromMcpServer": "<string>"
  }
}

Authorizations

x-maxim-api-key
string
header
required

API key for authentication

Body

application/json
workspaceId
string
required

Unique identifier for the workspace

id
string
required

Unique identifier for the prompt tool

name
string

Name of the prompt tool

description
string

Description of the prompt tool

config
Program · object

Configuration for the prompt tool

folderId
string | null

Folder ID

newWorkspaceId
string

New Workspace ID if moving

Response

Prompt tool updated successfully

data
object
required